home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 2 / Gold Medal Software Volume 2 (Gold Medal) (1994).iso / bbsutils / sappha.arj / INSTALL.DOC < prev    next >
Text File  |  1994-01-01  |  15KB  |  340 lines

  1.  
  2.    ===========================================================================
  3.    ===                                                                     ===
  4.    ===                      INSTALLATION INSTRUCTIONS                      ===
  5.    ===                                                                     ===
  6.    ===========================================================================
  7.  
  8.    
  9.  
  10.    MONEY-SAVER:  You do not have to install Sapphire on a "powerful" machine!
  11.    Sapphire is written very efficiently, which means you can run it on an old,
  12.    second-hand computer.  A 2400 baud Sapphire BBS works fine on an 8 MHz XT.
  13.    A 9600 baud machine will do fine on a 12 MHz machine.  Save your expensive,
  14.    high-speed system for yourself; Sapphire doesn't need all that horsepower!
  15.  
  16.    If you are upgrading from an earlier version of Sapphire, please install
  17.    this copy in a separate directory (and try it out, if you wish) then refer
  18.    to the upgrade section, which appears later in this document.
  19.  
  20.  
  21.                             -------------------------
  22.                             INSTALLATION ON HARD DISK
  23.                             -------------------------
  24.  
  25.  
  26.    -------
  27.    STEP #1  Check your CONFIG.SYS
  28.    -------
  29.  
  30.    When you start up your computer, it looks for a file named CONFIG.SYS in
  31.    the root directory of the boot drive (i.e.  A: on a diskette-only system,
  32.    or C: if you have a hard disk).  This file contains information about how
  33.    the system should run.
  34.  
  35.    CONFIG.SYS is a text file, so you can edit it (or create it, if it does not
  36.    already exist) using a text editor program such as DOS EDLIN, a
  37.    programmer's editor, or a word processor in non-document (generic DOS text)
  38.    mode.
  39.  
  40.    The CONFIG.SYS file should contain the following line:
  41.  
  42.    FILES=30
  43.  
  44.    If it does not, you should insert this on a separate line, starting in col-
  45.    umn one.  (If a higher value is shown, such as FILES=40, you can leave the
  46.    file the way it is.)
  47.  
  48.    For more information about this step, see the explanations of CONFIG.SYS
  49.    and EDLIN in your DOS manual.
  50.  
  51.    If you found it necessary to create or change the file, restart your
  52.    computer so that it can read in the new values you have specified.
  53.  
  54.  
  55.  
  56.    -------
  57.    STEP #2  Copy the files into their home directory.
  58.    -------
  59.  
  60.    IF YOU RECEIVED THE INSTALLATION DISK FROM PINNACLE SOFTWARE, you will have
  61.    already done this by inserting the diskette in the A: drive and typing A:GO
  62.    (or B:GO if you used the B: drive).
  63.  
  64.    IF YOU RECEIVED THE INSTALLATION DISK FROM SOMEONE ELSE, you should copy
  65.    all the files on that disk into a directory on your hard disk -- preferably
  66.    named SAPPHIRE.  Read the label on the diskette carefully -- some shareware
  67.    vendors use Pinnacle Software's GO program, or something similar, to do the
  68.    necessary copying for you.
  69.  
  70.    AT THIS POINT, ALL THE FILES SHOULD RESIDE IN A DIRECTORY ON YOUR HARD DISK
  71.  
  72.  
  73.  
  74.    -------
  75.    STEP #3  Try out Sapphire in demonstration mode.
  76.    -------
  77.  
  78.    At the DOS prompt, type SYSOP.  Then select the "DEMO" option.  This will
  79.    run Sapphire in demonstration mode.  When you are finished with Sapphire,
  80.    enter the BYE or CLOSE command, either of which close down Sapphire when it
  81.    is running in demonstration mode.
  82.  
  83.    If you run into problems, refer to the trouble-shooting guide, available
  84.    via SYSOP:INFO:TROUBLE.  (Enter SYSOP at the DOS prompt, select INFO, then
  85.    select TROUBLE)
  86.  
  87.  
  88.  
  89.    -------
  90.    STEP #4  Read the operations manual in SYSOP:INFO:MANUAL:BASIC.
  91.    -------
  92.  
  93.    At the DOS prompt, enter SYSOP.  Select INFO.  Select MANUAL, then BASIC.
  94.    You should familiarize yourself with basic operations, such as signing on
  95.    as sysop, and changing the sysop's password.
  96.  
  97.  
  98.  
  99.    -------
  100.    STEP #5  Configure Sapphire, using SYSOP:CONFIG.
  101.    -------
  102.  
  103.    For this step, you will need your modem's user manual.
  104.  
  105.    At the DOS prompt, enter SYSOP.  Select CONFIG.  Go through all the items
  106.    one at a time.  If you don't understand any of the configuration items, you
  107.    can press the F1 key to pop up a detailed explanation.
  108.  
  109.  
  110.  
  111.    -------
  112.    STEP #6  Run Sapphire locally (SYSOP:LOCAL).
  113.    -------
  114.  
  115.    At the DOS prompt, type SYSOP.  Select LOCAL.  This runs Sapphire without
  116.    referring to the modem.  This lets you check out its basic operations and
  117.    become more familiar with its commands without running into modem problems,
  118.    which are the most common source of difficulty for any new BBS.
  119.  
  120.    To sign on as sysop, press the spacebar to "wake up" the BBS.  When asked
  121.    for your name, press the spacebar, then hit Enter.  When asked for a
  122.    password, type "SYSOP".
  123.  
  124.    When you are finished, enter the CLOSE command to shut down Sapphire.
  125.  
  126.  
  127.  
  128.    -------
  129.    STEP #7  Run Sapphire remotely (SYSOP:STANDARD).
  130.    -------
  131.  
  132.    At the DOS prompt, enter SYSOP.  Select STANDARD.  This runs Sapphire in
  133.    the standard mode, using the modem.  If you have any problems with the
  134.    modem, refer to the trouble-shooting guide in SYSOP:INFO:TROUBLE.
  135.  
  136.    When Sapphire starts, you should see it having a brief dialog with the
  137.    modem. Once Sapphire displays "Waiting for Visitor", call in using another
  138.    modem and try signing up as a new user.
  139.  
  140.    When you are finished, press ALT-X while Sapphire is waiting for a visitor.
  141.    This will shut down Sapphire and reset the modem.
  142.  
  143.  
  144.  
  145.                             -------------------------
  146.                             INSTALLATION ON DISKETTES
  147.                             -------------------------
  148.  
  149.    Earlier versions of Sapphire were designed to allow a diskette-based
  150.    system, and this version retains the code written to support diskettes.
  151.    For example, the maximum length of messages is reduced to allow you to
  152.    store an entire message base on a 360K drive.  Also, the file-transfer
  153.    system is disabled, since it would be risky to allow uploads to diskettes
  154.    -- they could easily fill up the remaining space on the disk.
  155.  
  156.    It is quite difficult to make Sapphire v4.08 or later run on a system with
  157.    two 360K drives.  If you must run from floppies, try to install the largest
  158.    capacity drives your machine can use -- especially for the main programs
  159.    diskette (i.e. the diskette where SRUN.EXE resides, not the message-base
  160.    diskette; that one can safely use a 360K drive).
  161.  
  162.    Sapphire decides that it is running from diskettes if it sees A: or B: in
  163.    the paths of the configured directories, or if it finds itself (i.e.
  164.    SRUN.EXE) on the A: or B: drive.  You can defeat this behaviour by using
  165.    the DOS ASSIGN command (see your DOS manual for information about ASSIGN).
  166.  
  167.    Since there are now many different types of diskette drives, it is not
  168.    possible to recommend a single approach.  In general, you should configure
  169.    your smallest drive as the "message drive".  (Remember that it must contain
  170.    a directory for the messages -- the root directory has a limit on the
  171.    number of files it can hold).  On your larger diskette drive, put all of
  172.    the Sapphire files that you need, following these guidelines:
  173.  
  174.    1.  All documentation files (*.DOC) can be removed.  This will disable the
  175.        INFO section of the SYSOP utility.  You can also remove the READ.ME and
  176.        READ.ME2 files.
  177.  
  178.    2.  The SYSOP.BAT and INFO.BAT files can be removed IF you understand
  179.        enough about batch files to follow what they were doing.  If you remove
  180.        them, you can also remove the following files:
  181.  
  182.        GO-MENU.EXE, SEE.EXE, SAPPFIVE.EXE, SOUND.EXE, SEARCH.EXE, CHKFILES.EXE
  183.        FNAMES.FIV, SYSOP.MNU, INFO.MNU, MANUAL.MNU, MISC.MNU
  184.  
  185.        These files should be kept handy on a separate diskette, since they
  186.        contain much useful information.
  187.  
  188.        With SYSOP.BAT removed, you must run CONFIG.EXE directly from the DOS
  189.        prompt when you need to configure Sapphire.  You will also start
  190.        Sapphire directly from SAPPHIRE.BAT, as follows:
  191.  
  192.        Standard: SAPPHIRE
  193.        Local:    SAPPHIRE LOCAL
  194.        Demo:     SAPPHIRE DEMO
  195.  
  196.    3.  Modem-testing software can be removed: MODEM.EXE and TERM.BAT.  Keep
  197.        them handy, though, in case you have to call us for support.
  198.  
  199.    4.  Since file transfer is disabled on a diskette-based system, you can
  200.        removed DSZ.ARC and ARCE.COM.  If you have already installed the DSZ
  201.        archive, refer to the data file FNAMES.FIV for a list of the files it
  202.        contained.
  203.  
  204.    5.  Once you've got a registered copy of Sapphire, you can delete the files
  205.        ORDER.FRM and REGISTER.XXX.  Do NOT delete these files from an unregis-
  206.        tered copy; it will stop working.
  207.  
  208.    6.  As a last resort, if you are very short of space, you can remove the
  209.        GRA files (*.GRA) -- except for CKGRAPH.GRA, which is used by the
  210.        GRAPHICS command.  This will mean that your system will look basically
  211.        the same whether a user turns graphics on or off.
  212.  
  213.  
  214.  
  215.                        -------------------------------
  216.                        UPGRADING FROM EARLIER VERSIONS
  217.                        -------------------------------
  218.  
  219.   If you are upgrading from Sapphire v3.xx, refer to the section entitled
  220.   "Upgrading from Sapphire v3.xx" before reading this section.
  221.  
  222.   The article in SYSOP:INFO:MANUAL:NEW is the best place to find out what is
  223.   required when upgrading to the latest version.  If you've skipped a few
  224.   versions, though, you may wonder what steps are required.  Here is a summary
  225.   of the requirements to upgrade to Sapphire version 4.08:
  226.  
  227.   LAST VERSION    SPECIAL ACTIONS REQUIRED
  228.   -------------   ------------------------
  229.       4.07        None
  230.       4.06        None
  231.       4.05        None
  232.       4.04        None
  233.       4.03        Contact Pinnacle to get a serial (registration) number
  234.       4.02        The SAPPHIRE.CFG file is not compatible with later versions,
  235.                   so do a "print screen" on each of your CONFIG data screens,
  236.                   so you can re-enter them later.
  237.  
  238.   The document HISTORY.DOC (provided in the optional SAPPHC file collection --
  239.   usually distributed as SAPPHC.ZIP) describes, in detail, all the improve-
  240.   ments we have made to Sapphire in the past few years.
  241.                                         
  242.   Apart from the "Special Actions" (see above), upgrading from an older v4.xx
  243.   to a newer version involves these steps:
  244.  
  245.   1.  Install the new version in a NEW directory.  Do NOT install it in your
  246.       old directory (i.e. "on top of" your old Sapphire).
  247.  
  248.   2.  Make a backup of your old Sapphire directory.
  249.  
  250.   3.  Using our files database (SYSOP:INFO:FILES) as reference, determine
  251.       which stock files you have modified in the OLD directory, and copy them
  252.       to the NEW directory.
  253.                  
  254.   4.  Unless the "Special Actions" table above indicates that a particular
  255.       file is not compatible, copy over your data files:
  256.  
  257.       FILE NAME     PURPOSE                FILE NAME     PURPOSE
  258.       ------------  ---------------------  ------------  ---------------------
  259.       SAPPHIRE.ACT  ACTIVITY data          SAPPHIRE.CFG  Configuration data
  260.       SAPPHIRE.CTL  Door/event scheduling  SAPPHIRE.MSG  Message time data
  261.       SAPPHIRE.NXT  Next-message data      SAPPHIRE.LOG  OBSERVE data
  262.       SAPPHIRE.USR  User data
  263.  
  264.   5.  Keep the old version around for a few days, in case you forgot to move
  265.       anything over.  Bear in mind that if you copied over the old
  266.       SAPPHIRE.CFG to the new directory, it will point to your OLD
  267.       file and message directories.  You may find it convenient to copy the
  268.       contents of these directories to another directory (off the root
  269.       directory, perhaps) and point to them using SYSOP:CONFIG in the NEW
  270.       Sapphire.
  271.  
  272.  
  273.  
  274.                         -----------------------------
  275.                         UPGRADING FROM SAPPHIRE v3.xx
  276.                         -----------------------------
  277.  
  278.    If you are upgrading from Sapphire v3.x or earlier you will find that this
  279.    version is largely compatible.  To upgrade, follow the steps listed below.
  280.  
  281.    NOTE: If you had a registered version, the upgrade will NOT carry forward
  282.    your registration.  See the order form for information about our low-cost
  283.    upgrade policy.
  284.  
  285.    1.  Install Sapphire in a new directory.  (See "Installation on a Hard
  286.        Disk")
  287.  
  288.    2.  Test-run it and make sure it functions properly.  Do not skip this
  289.        step, because it is needed to ensure that all directories are present.
  290.  
  291.    3.  Copy the following files to the new directory:
  292.  
  293.                       NAME IN OLD  NAME IN NEW
  294.        FILE FUNCTION  DIRECTORY    DIRECTORY    COMMENTS
  295.        ─────────────  ───────────  ───────────  ─────────────────────
  296.        Messages       B*           Same         See Note #3.1
  297.        Upload files   *.*          Same         See Note #3.1
  298.        Activity       SACTI.DAT    SAPPHIRE.ACT
  299.        Control        SCTRL.DAT    SAPPHIRE.CTL
  300.        Message times  STIME.DAT    SAPPHIRE.MSG
  301.        Next message   SNEXT.DAT    SAPPHIRE.NXT
  302.        OBSERVE data   SSSYL.DAT    SAPPHIRE.LOG
  303.        Users          SUSER.DAT    SAPPHIRE.USR
  304.        Software       SSOFT.DAT    SAPPHIRE.SOF See Note #3.2
  305.  
  306.        NOTE #3.1: As an alternative to copying, you can point Sapphire at the
  307.        original directory, using SYSOP:CONFIG.
  308.  
  309.        NOTE #3.2: SSOFT.DAT will be present only if you have installed the
  310.        file transfer system.
  311.  
  312.    4.  Copy your text files.
  313.  
  314.        Earlier versions of Sapphire had some text in external text files, such
  315.        as SHINT.TXT.  This text is now stored in the STD files.
  316.  
  317.                       NAME IN OLD  NAME IN NEW
  318.        FILE FUNCTION  DIRECTORY    DIRECTORY    COMMEMTS
  319.        ─────────────  ───────────  ───────────  ─────────────────────
  320.        Sign-on logo   SLOGO.TXT    LOGOXX.STD   See Note #4.1
  321.        New user info  SNEWH.TXT    NEWHXX.STD
  322.        INFO           SINFO.TXT    INFOXX.STD
  323.        GIMMICKS       SGIMM.TXT    GIMMXX.STD
  324.        HINTS          SHINT.TXT    HINTXX.STD
  325.        GET            SGETF.TXT    GETFXX.STD
  326.        GIVE           SGIVE.TXT    GIVEXX.STD
  327.  
  328.        NOTE #4.1: In previous versions of Sapphire, you were able to put some
  329.        spare logos at the end of the SLOGO.TXT file.  This is not supported in
  330.        the LOGOXX.STD file, which must contain only the logo that will be
  331.        displayed when the user logs on.
  332.  
  333.    5.  (Optional) Copy over your command levels data.
  334.  
  335.        The file COMMANDS.LEV is the same as the old SCMDL.DAT file, except
  336.        that it contains more information.  Print out your old SCMDL.DAT file,
  337.        then use a text editor on COMMANDS.LEV to set it up your way.
  338.  
  339.  
  340.